package com.tx.core.ddlutil.model;

/**
 * 表索引接口<br/>
 * <功能详细描述>
 * getIndexInfo
 * <p>
 * NON_UNIQUE int => 非唯一索引
 * INDEX_QUALIFIER String => 索引目录（可为 null）
 * INDEX_NAME String => 索引的名称
 * TYPE short => 索引类型
 * ORDINAL_POSITION short => 在索引列顺序号
 * COLUMN_NAME String => 列名
 * ASC_OR_DESC String => 列排序顺序:升序还是降序
 * CARDINALITY int => 基数
 *
 * @author Administrator
 * @version [版本号, 2016年10月24日]
 * @see [相关类/方法]
 * @since [产品/模块版本]
 */
public interface TableIndexDef {

    /**
     * 索引名称<br/>
     * <功能详细描述>
     *
     * @return [参数说明]
     * @return String [返回类型说明]
     * @throws throws [异常类型] [异常说明]
     * @see [类、类#方法、类#成员]
     */
    public abstract String getName();

    /**
     * 是否唯一键<br/>
     * <功能详细描述>
     *
     * @return [参数说明]
     * @return boolean [返回类型说明]
     * @throws throws [异常类型] [异常说明]
     * @see [类、类#方法、类#成员]
     */
    public abstract boolean isUnique();

    /**
     * 获取对应的字段名<br/>
     * <功能详细描述>
     *
     * @return [参数说明]
     * @return String [返回类型说明]
     * @throws throws [异常类型] [异常说明]
     * @see [类、类#方法、类#成员]
     */
    public abstract String getColumnNames();

}